Updated doc for image and icon shapes #5945

saurabhg772244 · 2024-10-09T10:09:30Z

📑 Summary

Updated Documentation for Mermaid Flowcharts to include new special shapes: icon and image.
Separate out documentation for registering icon pack in mermaid. Added link in side-bar in config section.

📋 Tasks

Make sure you

📖 have read the contribution guidelines
💻 have added necessary unit/e2e tests.
📓 have added documentation. Make sure MERMAID_RELEASE_VERSION is used for all new features.
🦋 If your PR makes a change that should be noted in one or more packages' changelogs, generate a changeset by running pnpm changeset and following the prompts. Changesets that add features should be minor and those that fix bugs should be patch. Please prefix changeset messages with feat:, fix:, or chore:.

changeset-bot · 2024-10-09T10:09:34Z

⚠️ No Changeset found

Latest commit: a4fd422

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

netlify · 2024-10-09T10:09:47Z

✅ Deploy Preview for mermaid-js ready!

Name	Link
🔨 Latest commit	`a4fd422`
🔍 Latest deploy log	https://app.netlify.com/sites/mermaid-js/deploys/6707a2e0a2fea70008019b8c
😎 Deploy Preview	https://deploy-preview-5945--mermaid-js.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pkg-pr-new · 2024-10-09T10:10:42Z

Open in Stackblitz

pnpm add https://pkg.pr.new/mermaid-js/mermaid@5945

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/layout-elk@5945

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/mermaid-zenuml@5945

pnpm add https://pkg.pr.new/mermaid-js/mermaid/@mermaid-js/parser@5945

commit: a4fd422

codecov · 2024-10-09T10:12:50Z

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 4.64%. Comparing base (2933eb5) to head (a4fd422).
Report is 6 commits behind head on develop.

Files with missing lines	Patch %	Lines
packages/mermaid/src/docs/.vitepress/config.ts	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           develop   #5945      +/-   ##
==========================================
- Coverage     4.64%   4.64%   -0.01%     
==========================================
  Files          374     374              
  Lines        51964   51965       +1     
  Branches       613     613              
==========================================
  Hits          2414    2414              
- Misses       49550   49551       +1

Flag	Coverage Δ
unit	`4.64% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
packages/mermaid/src/docs/.vitepress/config.ts	`0.00% <0.00%> (ø)`

argos-ci · 2024-10-09T10:16:16Z

The latest updates on your projects. Learn more about Argos notifications ↗︎

Build	Status	Details	Updated (UTC)
default (Inspect)	✅ No changes detected	-	Oct 10, 2024, 9:55 AM

docs/syntax/flowchart.md

…saurabh/doc-update

packages/mermaid/src/docs/syntax/flowchart.md

packages/mermaid/src/docs/syntax/architecture.md

packages/mermaid/src/docs/config/icons.md

packages/mermaid/src/docs/.vitepress/config.ts

aloisklink · 2024-10-10T11:38:22Z

packages/mermaid/src/docs/syntax/flowchart.md

+
+```mermaid-example
+flowchart TD
+    A@{ icon: "fa:user", form: "square", label: "User Icon", pos: "t", h: 60 }


Could we switch to an icon pack that is available on our site, e.g.

Suggested change

A@{ icon: "fa:user", form: "square", label: "User Icon", pos: "t", h: 60 }

A@{ icon: "logos:zod", form: "square", label: "User Icon", pos: "t", h: 60 }

aloisklink · 2024-10-10T11:43:45Z

packages/mermaid/src/docs/syntax/flowchart.md

+
+```mermaid-example
+flowchart TD
+    A@{ img: "https://example.com/image.png", label: "Image Label", pos: "t", w: 60, h: 60, constraint: "off" }


This image URL is invalid and causes an error.

Could we maybe switch to an image already hosted on our site, e.g.

Suggested change

A@{ img: "https://example.com/image.png", label: "Image Label", pos: "t", w: 60, h: 60, constraint: "off" }

A@{ img: "https://mermaid.js.org/favicon.svg", label: "Image Label", pos: "t", w: 60, h: 60, constraint: "off" }

(although, w: 60, h:60 doesn't seem to set the image height correctly, for some reason, due to the label)

Updated doc for image and icon shapes

09ecf76

saurabhg772244 requested review from knsv, sidharthv96, ashishjain0512 and aloisklink October 9, 2024 10:09

sidharthv96 requested changes Oct 9, 2024

View reviewed changes

docs/syntax/flowchart.md Outdated Show resolved Hide resolved

saurabhg772244 added 2 commits October 10, 2024 12:26

Merge branch 'develop' of https://github.com/mermaid-js/mermaid into …

351ce30

…saurabh/doc-update

Added new doc for registering icon pack in mermaid

9f6f1e9

saurabhg772244 requested a review from sidharthv96 October 10, 2024 07:44

sidharthv96 requested changes Oct 10, 2024

View reviewed changes

saurabhg772244 added 2 commits October 10, 2024 14:15

Moved position for icon config and added major version in icon docs

ca88502

Use relative URL in linking docs

a4fd422

sidharthv96 approved these changes Oct 10, 2024

View reviewed changes

sidharthv96 merged commit f859772 into develop Oct 10, 2024
25 checks passed

sidharthv96 deleted the saurabh/doc-update branch October 10, 2024 11:16

aloisklink reviewed Oct 10, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Updated doc for image and icon shapes #5945

Updated doc for image and icon shapes #5945

saurabhg772244 commented Oct 9, 2024 •

edited by sidharthv96

Loading

changeset-bot bot commented Oct 9, 2024 •

edited

Loading

netlify bot commented Oct 9, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 9, 2024 •

edited

Loading

codecov bot commented Oct 9, 2024 •

edited

Loading

argos-ci bot commented Oct 9, 2024 •

edited

Loading

aloisklink Oct 10, 2024

aloisklink Oct 10, 2024

	A@{ icon: "fa:user", form: "square", label: "User Icon", pos: "t", h: 60 }
	A@{ icon: "logos:zod", form: "square", label: "User Icon", pos: "t", h: 60 }

	A@{ img: "https://example.com/image.png", label: "Image Label", pos: "t", w: 60, h: 60, constraint: "off" }
	A@{ img: "https://mermaid.js.org/favicon.svg", label: "Image Label", pos: "t", w: 60, h: 60, constraint: "off" }

Updated doc for image and icon shapes #5945

Updated doc for image and icon shapes #5945

Conversation

saurabhg772244 commented Oct 9, 2024 • edited by sidharthv96 Loading

📑 Summary

📋 Tasks

changeset-bot bot commented Oct 9, 2024 • edited Loading

⚠️ No Changeset found

netlify bot commented Oct 9, 2024 • edited Loading

✅ Deploy Preview for mermaid-js ready!

pkg-pr-new bot commented Oct 9, 2024 • edited Loading

codecov bot commented Oct 9, 2024 • edited Loading

Codecov Report

argos-ci bot commented Oct 9, 2024 • edited Loading

aloisklink Oct 10, 2024

Choose a reason for hiding this comment

aloisklink Oct 10, 2024

Choose a reason for hiding this comment

saurabhg772244 commented Oct 9, 2024 •

edited by sidharthv96

Loading

changeset-bot bot commented Oct 9, 2024 •

edited

Loading

netlify bot commented Oct 9, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 9, 2024 •

edited

Loading

codecov bot commented Oct 9, 2024 •

edited

Loading

argos-ci bot commented Oct 9, 2024 •

edited

Loading